-
Notifications
You must be signed in to change notification settings - Fork 96
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for shadow DOM #604 #606
Conversation
Nice work @dgr! Thanks for taking so much care! Some thoughts/ideas/observations: Maybe docstrings could link to Etaoin user guide which in turn could link to https://wpt.fyi/results/webdriver/tests/classic/find_element_from_shadow_root/find.py?label=experimental&label=master&aligned in a prominent adoc NOTE. This way users would get a link to your very nice overview of the shadow dom (I read, I learned!) AND a link to current implementation limitations. Whaddya think? Test-doc is failing because code blocks will return different results each time they are run. For example, this gets converted into a test: (e/get-element-shadow-root driver {:id "shadow-root-host"})
;; => "ac5ab914-7f93-427f-a0bf-f7e91098fd37" which expects a return of Options:
I reviewed the user guide for what strategy I took for the element id returns, and it looks like I entirely avoided it in code blocks. It seems I spent a little bit of time upfront describing the difference between -el and non-el variants and didn't dwell on it at all later. For me, it is a balance between "what does the reader need to see to understand this?" and "can I ensure that the code blocks should always work in the reader's REPL when they try them out?". Anyhoo, great work, and I am happy to work out the above with you further. |
OK, let me do one more commit with updates to doc strings and doc-test stuff. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Getting real close @dgr! Just a few minor things I noticed.
OK, try it again. |
Looks great @dgr, thanks! |
Please complete and include the following checklist:
[x ] I have read CONTRIBUTING and the Etaoin Developer Guide.
[x ] This PR corresponds to an issue that the Etaoin maintainers have agreed to address.
[x ] This PR contains test(s) to protect against future regressions
[x ] I have updated CHANGELOG.adoc with a description of the addressed issue.